home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / share / ghostscript / 8.64 / Resource / Init / pdf_rbld.ps < prev    next >
Encoding:
Text File  |  2009-04-17  |  14.7 KB  |  345 lines
  1. %    Copyright (C) 2002 Artifex Software, Inc.  All rights reserved.
  2. % 
  3. % This software is provided AS-IS with no warranty, either express or
  4. % implied.
  5. % 
  6. % This software is distributed under license and may not be copied,
  7. % modified or distributed except as expressly authorized under the terms
  8. % of the license contained in the file LICENSE in this distribution.
  9. % 
  10. % For more information about licensing, please refer to
  11. % http://www.ghostscript.com/licensing/. For information on
  12. % commercial licensing, go to http://www.artifex.com/licensing/ or
  13. % contact Artifex Software, Inc., 101 Lucas Valley Road #110,
  14. % San Rafael, CA  94903, U.S.A., +1(415)492-9861.
  15.  
  16. % $Id: pdf_rbld.ps 9175 2008-10-19 20:32:03Z alexcher $
  17. % pdf_rbld.ps - Rebuilding of broken PDF files (xref errors)
  18.  
  19. % This module contains routines that are used if we detect an error
  20. % while reading the xref tables.  These routines will scan the file and
  21. % build an xref table by finding the objects.  We also need to find the
  22. % appropriate trailer dictionary.  Note:  One procedure is also used
  23. % even if we do not need to rebuild a PDF file.
  24. %
  25. % This module cannot rebuild a PDF file which has had errors created inside
  26. % of objects or binary data streams.  It often succeeds with files that
  27. % have had its end of lines converted between unix and dos versions.
  28.  
  29. % if true --> we have an object with duplicate object and generation numbers.
  30. /dup_obj_gen_num false def
  31.  
  32. % Note:  This procedure is also used by non-rebuild code.
  33. % Store a line in the xref array (Actually Objects and Generations arrays)
  34. % <obj num> (strm num> <obj loc> <gen num> <rebuild>
  35. %                         setxrefentry <obj num> strm num> <obj loc> <gen num>
  36. /setxrefentry
  37. {
  38.   5 1 roll
  39.   dup 65535 or 65535 ne {
  40.     (   **** Warning:  Generation number out of 0..65535 range, assuming 0.\n)
  41.     pdfformaterror
  42.     pop 0
  43.   } if
  44.            % We store generation numbers as value + 1
  45.     % We reserve 0 to indicate an free xref entry
  46.   1 add            % increment generation number
  47.     % To save space, generations numbers are stored in a lstring unless we
  48.     % find a generation number greater than 255.  If so then transfer to 
  49.     % an larray.
  50.   dup 255 gt {
  51.     Generations ltype /stringtype eq {    % Convert Generations to an larray.
  52.       larray Generations llength lgrowto dup    % Create new larray
  53.       0 1 2 index llength 1 sub {    % Copy from old lstring to new larray
  54.     Generations 1 index lget lput dup
  55.       } for
  56.       pop
  57.       /Generations exch store        % Save new Generations larray
  58.     } if
  59.   } if
  60.     % Verify that the new values are for a new object.  If the current
  61.     % entry is null then we have a new entry.
  62.   Objects 4 index lget null eq {
  63.     ObjectStream 4 index 4 index cvx lput % Save ObjectStream object number
  64.     Objects 4 index 3 index cvx lput    % Save object location
  65.     Generations 4 index 2 index lput    % Save geenration number
  66.   } {
  67.     % Verify that the new entry has at least as high a generaton number
  68.     % We accept equal entry number because we have found PDF files in
  69.     % which there are multiple objects with the same object and entry
  70.     % numbers.  The normal xref logic only accepts the first such
  71.     % entry that it finds.  However the 'rebuild PDF' logic can find
  72.     % both such entries.  The correct one is usually the last one.
  73.     Generations 4 index lget 1 index le {
  74.       ObjectStream 4 index 4 index cvx lput % Save ObjectStream object number
  75.       Objects 4 index 3 index cvx lput    % Save object location
  76.       Generations 4 index 2 index lput    % Save geenration number
  77.     } if
  78.     % Set error flag if we have equal object and generation numbers
  79.     Generations 4 index lget 1 index eq { /dup_obj_gen_num true def } if
  80.   } 8 -1 roll { ifelse } { pop if } ifelse  % Run 'else' only when rebuilding.
  81. } bind def
  82.  
  83. % Print the contents of the xref array.  This actually consists of three
  84. % arrays (Objects, Generations, and ObjectStream).  All three are larrays.
  85. % larrays are a special Ghostscript object which can be arrays with more
  86. % than 64k elements.
  87. /print_xref                % - print_xref -
  88. { 0 1 Objects llength 1 sub        % stack: 0 1 <number of objects - 1>
  89.   { dup =only                % print object number
  90.     (  ) print
  91.     dup Generations exch lget 1 sub =only % print Generation number
  92.     (  ) print
  93.     dup ObjectStream exch lget ==only    % print ObjectStream object number
  94.     (  ) print
  95.     Objects exch lget ===        % print object location
  96.   } for
  97.   flush
  98. } bind def
  99.  
  100. % Get token from string and check its type
  101. %   <string> <type> typed_token <false>        % no token or not match
  102. %   <string> <type> typed_token <obj> <last> <true>    % matching token type
  103. % Where last is the string remainder
  104. /typed_token
  105. { exch
  106.   token_nofail            % get token
  107.   {
  108.     dup type            % stack:  type last token type
  109.     4 -1 roll eq {        % stack:  last token bool
  110.       exch true            % desired object found - set exit status
  111.     } {
  112.       pop pop false        % not type - clear stack, set exit status
  113.     } ifelse
  114.   } {
  115.     pop false            % no token - pop type, set exit status
  116.   } ifelse            % check if we got token
  117. } bind def
  118.  
  119. % Allocate space for post_eof_count to be bound into procedures below.
  120. /post_eof_count 0 def
  121.  
  122. % We want the location of the trailer dictionary at the start of file.
  123. % First we will find the xref.  Then we will skip over the xref entries
  124. % to the trailer.
  125. /search_start_trailer        % - search_start_trailer <trailer loc>
  126. { % Read the first 300 bytes and check for xref
  127.   PDFfile 0 setfileposition
  128.   PDFfile bytesavailable post_eof_count sub    % location of end of data
  129.   300 .min            % block size to read
  130.   dup string 0 1 4 -1 roll 1 sub
  131.   { 2 copy PDFfile read pop put pop } for
  132.   (xref) search {
  133.     % found 'xref'
  134.     exch pop exch pop length 4 add PDFfile exch setfileposition
  135.     PDFfile token pop        % get starting entry - or 'trailer'
  136.     (trailer) ne {        % if we do not already have 'trailer'
  137.       PDFfile token pop        % get number of entries
  138.       PDFfile token pop pop    % this moves us into the middle of the first entry
  139.       25 string exch        % define working string for readline
  140.       { PDFfile 1 index readline pop pop
  141.       } repeat            % skip entries
  142.       pop            % pop working string
  143.       PDFfile token pop pop    % get 'trailer'
  144.       PDFfile fileposition    % get file position
  145.     } if
  146.   } {
  147.     pop search_end_trailer    % no xref, should not happen, search end of file
  148.   } ifelse
  149. } bind def
  150.  
  151. % We want the location of the trailer dictionary at the end of file.
  152. % We will read the last block of data and search for the final occurance
  153. % of the word 'trailer'
  154. /search_end_trailer        % - search_end_trailer <trailer loc>
  155. { % Position to read block of data from the end of the file.  Note:  We ignore
  156.   % anything past the last %%EOF since this is not PDF data.
  157.   PDFfile 0 setfileposition
  158.   PDFfile bytesavailable post_eof_count sub    % location of end of data
  159.   dup 65535 .min        % block size to read
  160.                 % stack: <file end pos> <block size>
  161.   % move file position to the start of the block
  162.   2 copy sub PDFfile exch setfileposition
  163.   % read block of data
  164.   dup string 0 1 4 -1 roll 1 sub { 2 copy PDFfile read pop put pop } for
  165.   % search for last occurance of 'trailer'
  166.   (trailer) { search not { exit } if pop } loop
  167.   % determine where the trailer is in the file
  168.   %   trailer loc = end loc - remaing string length
  169.   length sub 
  170. } bind def
  171.  
  172. % We want to find the trailer dictionary.  There is a trailer dictionary
  173. % for each xref object list.  We only want the trailer dictionary associated
  174. % with the first xref object list.  In theory this can be anywhere in the
  175. % file.  However since we are trying to repair a broken file, we cannot simply
  176. % follow the xref links.  So we are falling back to a simple strategy.  We
  177. % find the specified location of the first xref list.  If its location is in
  178. % the first half of the file then we search for the first trailer dictionary
  179. % at the start of the file.  Otherwise we search for the last trailer at the
  180. % end of the file.
  181. /search_trailer            % - search_trailer -
  182. { % Find the 'startxref' and associated position at the end of the file.
  183.   % Position to read block of data from the end of the file.  Note:  We
  184.   % actually end at the end of the last %%EOF since this is the end of the
  185.   % useful PDF data.  (Some files contain trailing garbage.)
  186.   PDFfile 0 setfileposition
  187.   PDFfile bytesavailable    % size of file
  188.   post_eof_count sub dup    % location of end of last %%EOF
  189.   dup 4096 .min            % block size to read
  190.   % stack: <useful file size> <useful file size file> <block size>
  191.   % move file position to the start of the block
  192.   2 copy sub PDFfile exch setfileposition
  193.   % read block of data
  194.   dup string 0 1 4 -1 roll 1 sub { 2 copy PDFfile read pop put pop } for
  195.   % search for last occurance of 'startxref'
  196.   false                % Assume that startxref not present
  197.   exch (startxref) { 
  198.      search not { exit } if    % Exit loop when no more startxref's
  199.      pop 3 -1 roll pop true 3 1 roll    % Idicate that we have found starxref
  200.   } loop
  201.   exch                % Exch last string and 'found' flag
  202.   { 
  203.      % determine where the startxref is in the file
  204.      %   'startxref' loc = end loc - remaing string length - 9 bytes
  205.      length sub 9 sub
  206.      % move the file to this position and read startxref and position
  207.      PDFfile exch setfileposition PDFfile token
  208.      pop pop PDFfile token pop
  209.   } {
  210.      % startxref not found.  We will search the end of the file for trailer.
  211.      pop pop PDFfilelen
  212.   } ifelse
  213.   % compare xref position to 1/2 the length of the file and search for trailer
  214.   exch 2 div lt { search_start_trailer } { search_end_trailer } ifelse
  215.   % get the trailer
  216.   PDFfile exch setfileposition        % set to the specified trailer location
  217.   /dictlevelcount 0 def
  218.   PDFfile traileropdict .pdfrun        % read trailer info
  219.   /Trailer exch def
  220. } bind def
  221.  
  222. % This routine will determine if there is stuff after the %%EOF.  There is
  223. % supposed to be only a line termination.  However many real life files
  224. % contain some garbage.  This routine checks how much.  We then ignore this
  225. % stuff when we are scanning for objects.
  226. /determine_post_eof_count        % - determine_post_eof_count <count>
  227. { % Position to read block of data from the end of the file. 
  228.   PDFfilelen            % size of file
  229.   dup 4096 .min                    % file_size block_size
  230.   dup 3 1 roll sub              % block_size file_size-block_size 
  231.   PDFfile exch setfileposition  % block_size
  232.   string PDFfile exch readstring pop % ()
  233.  
  234.   % search for last occurance of 'startxref', '%%EOF' is often damaged
  235.   (startxref) {
  236.     search not { exit } if pop
  237.   } loop
  238.   % how much is left = remaining string length
  239.  
  240.   % Now search for %%EO or try to read a number after 'startxref'.
  241.   (%%EO) search {
  242.     pop pop 
  243.   } {
  244.     % Look for a number after startxref
  245.     { dup token { pop exch pop } if
  246.     } stopped {
  247.       pop
  248.     } if
  249.   } ifelse
  250.   length
  251. } bind def
  252.  
  253. % This routine will scan a file searaching for object locations to build
  254. % an alternate version of the data in the xref tables.
  255. % Its purpose is to provide a basis for an xref fixing facility.
  256. /search_objects                % - search_objects -
  257. { % Initialize the Objects, Generations, etc. larrays
  258.   initPDFobjects
  259.   % reset duplicate object and generation numbers error flag
  260.   /dup_obj_gen_num false def
  261.   % Determine how many bytes are in the file after the final %%EOF
  262.   /post_eof_count determine_post_eof_count def
  263.   % Start at the beginning of the file
  264.   PDFfile 0 setfileposition
  265.   % Create a working string (and also store its length on stack).  We are
  266.   % using a maximum size string size the logic below wants a recovered object
  267.   % to fit into our working string.
  268.   65535 dup string
  269.   { % Now loop through the entire file lloking for objects
  270.     PDFfile fileposition        % save current file position
  271.     % When we get near the end of the file, we use a smaller interval of
  272.     % our working string to prevent reading past the end.  (See comments on
  273.     % EOF testing below.)
  274.     PDFfile bytesavailable post_eof_count sub 10 sub dup 4 index lt {
  275.       2 index 0 3 -1 roll getinterval    % near EOF, use interval of string
  276.     } { pop 1 index            % not near end, use full working string
  277.     }ifelse
  278.     % Read a line from file.  If the line does not fit into our working string,
  279.     % or any other error, then we will discard it.
  280.     PDFfile exch { readline } .internalstopped
  281.     { pop pop false } if        % indicate no string if we stopped
  282.     { % stack: <length> <working_str> <loc> <string>
  283.       % Now that we have line, get obj num, ref num, and 'obj'.  Verify that each
  284.       % of these is correct type.
  285.       /integertype typed_token {    % get obj number
  286.         /integertype typed_token {    % get ref number
  287.           /nametype typed_token {    % get 'obj' text
  288.         pop                % pop remaining string
  289.         /obj eq {            % verify name is 'obj'
  290.           % make sure we have room in the arrays.  We work in increments
  291.           % of 20 each time we increase the size.
  292.           1 index 20 add 20 idiv 20 mul
  293.           growPDFobjects
  294.           % save xref parameters into ObjectStream, Objects and Generations
  295.           1 index 0            % rearrange parms for setxrefentry
  296.           4 index PDFoffset sub 3 index
  297.           //true setxrefentry    % save parameters
  298.           pop pop pop pop        % clear parameters
  299.         } if            % check if name is 'obj'
  300.           } if                % check if we got 'obj" string
  301.           pop                % remove ref number
  302.         } if                % check if we got ref number
  303.         pop                % remove obj number
  304.       } if                % check if we got object number
  305.     } if                % check if got a string from readline
  306.     pop                    % remove location
  307.     % Check if we are approaching the end of the file.  We do not want to
  308.     % read past the end of the file since that closes it.  We actually stop
  309.     % 10-20 bytes early since there cannot be an object that close to the end.
  310.     % (There is a Trailer dictionary, etc. at the end of the file.)
  311.     PDFfile bytesavailable post_eof_count sub 20 lt { exit } if
  312.   } loop                % loop through the entire file
  313.   pop pop                % remove working string and its length
  314.   % Output warning if we have two objects with the same object and generation
  315.   % numbers.
  316.   dup_obj_gen_num {
  317.     (   **** Warning:  There are objects with matching object and generation\n)
  318.     pdfformaterror
  319.     (   **** numbers.  The accuracy of the resulting image is unknown.\n)
  320.     pdfformaterror
  321.   } if
  322. } bind def
  323.  
  324. % Print warning message because we found a problem while reading the xref
  325. % tables
  326. /print_xref_warning
  327. { (   **** Warning:  An error occurred while reading an XREF table.\n)
  328.   pdfformaterror
  329.   (   **** The file has been damaged.  This may have been caused\n)
  330.   pdfformaterror
  331.   (   **** by a problem while converting or transfering the file.\n)
  332.   pdfformaterror
  333.   (   **** Ghostscript will attempt to recover the data.\n)
  334.   pdfformaterror
  335. } bind def
  336.  
  337. % Attempt to recover the XRef data.  This is called if we have a failure
  338. % while reading the normal XRef tables.  This routine usually works
  339. % only for pre PDF1.5 versions of PDF files.
  340. /recover_xref_data        % - recover_xref_data -
  341. { print_xref_warning        % Print warning message
  342.   count pdfemptycount sub { pop } repeat % remove anything left by readxref
  343.   search_objects        % Search for objects
  344. } bind def
  345.